home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / IC Component Source ƒ / IC Headers ƒ / IC Component API Descriptions.h < prev    next >
Encoding:
Text File  |  1995-11-17  |  22.2 KB  |  90 lines  |  [TEXT/SPM ]
  1. /*
  2.     Component Interface.h
  3.     
  4.     Describes the component interface routines and their parameters.
  5.     
  6.     Important note about naming conventions:  Read the file "API Readme.h" to understand
  7.     the prefixes used in all of the calls...
  8. */
  9.  
  10. #if 0 // don't include into compilation of code
  11.  
  12. /* ***** Starting Up and Shutting Down ***** */
  13.  
  14. pascal ICError ICCStart(internetConfigurationComponent *inst, OSType creator);
  15. /*
  16.     Call this at application initialisation. Set creator to your application
  17.     creator to allow for future expansion of the IC system. Returns
  18.     inst as a connection to the IC system.
  19. */
  20.  
  21. pascal ICError ICCStop(internetConfigurationComponent inst);
  22. /*
  23.     It is illegal to call this routine inside a ICBegin/End pair.
  24.     
  25.     Call this at application initialisation, after which inst
  26.     is no longer valid connection to IC.
  27. */
  28.  
  29. /* ***** Specifying a Configuration ***** */
  30.  
  31. pascal ICError ICCFindConfigFile(internetConfigurationComponent inst, short count, ICDirSpecArrayPtr folders);
  32. /*
  33.     It is illegal to call this routine inside a ICBegin/End pair.
  34.     
  35.     Call to configure this connection to IC.
  36.     Set count as the number of valid elements in folders.
  37.     Set folders to a pointer to the folders to search.
  38.     Setting count to 0 and folders to nil is OK.
  39.     Searches the specified folders and then the Preferences folder
  40.     in a unspecified manner.
  41. */
  42.  
  43. pascal ICError ICCFindUserConfigFile(internetConfigurationComponent inst, ICDirSpec *where)
  44. /*
  45.     Requires IC 1.1.
  46.     
  47.     It is illegal to call this routine inside a ICBegin/End pair.
  48.     
  49.     Similar to ICFindConfigFile except that it only searches the folder
  50.     specified in where.  If the input parameters are valid the routine
  51.     will always successful configure the instance, creating an
  52.     empty configuration if necessary
  53.     For use with double-clickable preference files.
  54. */
  55.  
  56. pascal ICError ICCGeneralFindConfigFile(internetConfigurationComponent inst, Boolean search_prefs, Boolean can_create,
  57.         short count, ICDirSpecArrayPtr folders)
  58. /*
  59.     Requires IC 1.2.
  60.     
  61.     It is illegal to call this routine inside a ICBegin/End pair.
  62.     
  63.     Call to configure this connection to IC.
  64.     This routine acts as a more general replacement for
  65.     ICFindConfigFile and ICFindUserConfigFile.
  66.     Set search_prefs to true if you want it to search the preferences folder.
  67.     Set can_create to true if you want it to be able to create a new config.
  68.     Set count as the number of valid elements in folders.
  69.     Set folders to a pointer to the folders to search.
  70.     Setting count to 0 and folders to nil is OK.
  71.     Searches the specified folders and then optionally the Preferences folder
  72.     in a unspecified manner.
  73. */
  74.  
  75. pascal ICError ICCChooseConfig(internetConfigurationComponent inst)
  76. /*
  77.     Requires IC 1.2.
  78.     
  79.     It is illegal to call this routine inside a ICBegin/End pair.
  80.     
  81.     Requests the user to choose a configuration, typically using some
  82.     sort of modal dialog. If the user cancels the dialog the configuration
  83.     state will be unaffected.
  84. */
  85.  
  86. pascal ICError ICCChooseNewConfig(internetConfigurationComponent inst)
  87. /*
  88.     Requires IC 1.2.
  89.     
  90.     It is illegal to call this routine inside a ICBegin/End p